home *** CD-ROM | disk | FTP | other *** search
/ Risc OS Programmer's Reference Manuals / Risc OS Programmer's Reference Manuals.iso / HTML / OVERVIEWS / README.TXT < prev   
Encoding:
Text File  |  2000-02-01  |  1.9 KB  |  62 lines
  1. Overview index file format
  2. ==========================
  3.  
  4. The main HTML overview file is a little clumbersome to search. Consequently,
  5. some users will wish to write their own front ends to launch the correct
  6. section of the manuals without as much work. To allow this, the
  7. 'overview.idx' file is provided. This is a relatively simple file format
  8. which should be parsable in any language with very little work.
  9.  
  10. The file consists of three blocks :
  11.   * the files block
  12.   * the sections block
  13.   * the SWI/service/command block
  14.  
  15. It is not expected that all the information be useful to everyone, but it may
  16. remove the need to manually index the manuals.
  17.  
  18.  
  19. Files
  20. -----
  21. The files block starts each line with a > character. The format is :
  22.  
  23.   >filename.HTML description
  24.  
  25. This block is provided so that you can give a quick index of all of the
  26. sections.
  27.  
  28.  
  29. Sections
  30. --------
  31. The sections block is consists of a heading of the same format as the
  32. file block lines, but starting with a :
  33.  
  34.   :filename.HTML description
  35.  
  36. Each subsequent line describes a heading in that file. This has the form :
  37.  
  38.   num anchor description
  39.  
  40. where num is the heading number. 1 being biggest, 6 being smallest.
  41.       anchor is the anchor name used in the file to find that heading. You
  42.              can't really rely on it being called anything; anchor names
  43.              have been generated automatically.
  44.       description is the heading description.
  45.  
  46.  
  47. SWI/Service/Commands
  48. --------------------
  49. This block contains a list of file/anchor pairs and descriptions. It is an
  50. extracted version of the h5 tag which refers to purely the "right-aligned"
  51. sections (generally SWIs/Services/* Commands). This is likely to be useful
  52. if you provide hotkey lookups. The lines start with an = sign :
  53.  
  54.   =filename.HTML#anchor description
  55.  
  56. which describes each of the locations.
  57.  
  58.  
  59. Disclaimer
  60. ----------
  61. No warranty is given for the correctness of these indices.
  62.